Change pdata generated types to use type definition instead of aliases #5936
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
bogdandrutu
force-pushed
the
usedypedef
branch
8 times, most recently
from
00dbeab to
c065c0c
Compare
Codecov Report
@@ Coverage Diff @@
## main #5936 +/- ##
==========================================
+ Coverage 91.90% 92.30% +0.39%
==========================================
Files 200 212 +12
Lines 12414 13249 +835
==========================================
+ Hits 11409 12229 +820
- Misses 793 803 +10
- Partials 212 217 +5
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
bogdandrutu
force-pushed
the
usedypedef
branch
from
c065c0c to
decef68
Compare
bogdandrutu
changed the title
bogdandrutu
force-pushed
the
usedypedef
branch
from
decef68 to
931aaf7
Compare
bogdandrutu
force-pushed
the
usedypedef
branch
2 times, most recently
from
56b0107 to
beea276
Compare
Change the way how objects are generated in `pdata`. Previously the pdata objects were generated in the `internal` package and aliases were created in the public packageas.
This PR changes this, by creating only "wrappers" object inside the internal package, and the public type is a type def of the internal type:
```golang
package internal
type LogRecord struct {
orig *otlplogs.LogRecord
}
func GetOrigLogRecord(ms LogRecord) *otlplogs.LogRecord {
return ms.orig
}
func NewLogRecord(orig *otlplogs.LogRecord) LogRecord {
return LogRecord{orig: orig}
}
```
```golang
package plog
type LogRecord internal.LogRecord
```
With this approach, we still do not allow users access to the internal origin, which allows us flexibility to change to other representation (something like lazy proto, etc), but improves documentation of the pdata packages, see [current documentation](https://pkg.go.dev/go.opentelemetry.io/collector/[email protected]/plog).
Signed-off-by: Bogdan <[email protected]>
bogdandrutu
force-pushed
the
usedypedef
branch
from
beea276 to
474d968
Compare
dmitryax
reviewed
Aug 24, 2022
I believe the compiler should be smart enough to not have to do this :) |
bogdandrutu
added a commit
to bogdandrutu/opentelemetry-collector
that referenced
this pull request
Aug 30, 2022
The mistake happened in open-telemetry#5936 Signed-off-by: Bogdan <[email protected]>
bogdandrutu
added a commit
that referenced
this pull request
Aug 30, 2022
The mistake happened in #5936 Signed-off-by: Bogdan <[email protected]> Signed-off-by: Bogdan <[email protected]>
This was referenced Sep 28, 2022
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Change the way how objects are generated in
pdata. Previously the pdata objects were generated in theinternalpackage and aliases were created in the public packageas.This PR changes this, by creating only "wrappers" object inside the internal package, and the public type is a type def of the internal type:
With this approach, we still do not allow users access to the internal origin, which allows us flexibility to change to other representation (something like lazy proto, etc), but improves documentation of the pdata packages, see current documentation.
Signed-off-by: Bogdan [email protected]